/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

#ifndef UNIVPLAN_SRC_UNIVPLAN_COMMON_SUBPLAN_UTIL_H_
#define UNIVPLAN_SRC_UNIVPLAN_COMMON_SUBPLAN_UTIL_H_

#include <vector>

#include "univplan/common/univplan-type.h"
#include "univplan/proto/universal-plan.pb.h"

namespace univplan {

class SubplanUtil {
 public:
  // @return Return related subplan IDs.
  static std::vector<int32_t> getRelatedSubplanIds(
      const UnivPlanPlanNodePoly& planNodePolyInput);

  // Link subplan to its correlated plan stage.
  // Inside stage, each subplan expression will change its planId to a
  // new number according to the order of attaching subplans.
  //
  // @param rootPlan The plan that contains fully stagized subplans.
  static void linkSubplan(UnivPlanPlan* rootPlan, UnivPlanPlan* currStage);
};

}  // namespace univplan

#endif  // UNIVPLAN_SRC_UNIVPLAN_COMMON_SUBPLAN_UTIL_H_
